Get accounting rule
Retrieve a single accounting rule by its identifier.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Unique identifier of the accounting rule.
"arl_abc123def456"
Auto-generated rule code (e.g. R-001).
"R-001"
Optional user-defined name for the rule.
"Recurring subscriptions"
Identifier of the ledger this rule belongs to.
"led_abc123def456"
Rule category (e.g. accounting_software, invoice_posted).
"accounting_software"
Override order. Higher priority wins when multiple rules match.
100
Product IDs to match. Empty means match all.
Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.
Customer IDs for customer-specific overrides.
Currency codes to match (e.g. EUR, USD).
Currency code. See ISO 4217.
EUR, AED, AFN, XCD, ALL, AMD, AOA, ARS, USD, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, XOF, BMD, BND, BOB, BRL, BSD, BTN, NOK, BWP, BYR, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUP, CVE, ANG, CZK, DJF, DKK, DOP, DZD, EGP, MAD, ERN, ETB, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ZMW, ZWL Country codes for jurisdiction-based overrides.
Two-letter country code in ISO format. See ISO 3166-1 alpha-2.
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BF, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ES-CE, ES-ML, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PT-20, PT-30, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.
standard, reverse_charge, exempt, not_eligible, manual Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.
Two-letter country code in ISO format. See ISO 3166-1 alpha-2.
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BF, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ES-CE, ES-ML, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PT-20, PT-30, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.
standard_rate, reduced_rate, reduced_rate_alt, super_reduced_rate, parking_rate, exempt, reverse_charge Coupon IDs to match. Empty means match all.
Client provider IDs to match. Empty means match all.
Payment method types to match. Empty means match all.
card, transfer, transfer_automated, direct_debit, direct_debit_ach, direct_debit_bacs, apple_pay, google_pay, paypal, stripe_link, external Bank account IDs to match. Empty means match all.
Invoice kinds to match: invoice or document. Refunds and other standard invoices match as invoice. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.
invoice, document Billing interval period filter (months, years, etc.).
days, weeks, quarters, months, years, once, all "months"
Billing interval count filter.
1
Invoice custom property filters. A rule matches only when every entry matches (AND across entries), and an entry matches when the invoice value is one of its values (any-of). Matching is strict: an invoice without a value for the property never matches. Each entry adds 10 to the suggested_priority returned by the rule defaults endpoint. Allowed on invoice_posted, invoice_settled, revenue_recognition, credit_note_created and accounting_software (invoice side) rules. An invoice_settled rule with filters cannot set payments_clearing_ledger_account_id, as PSP payouts are booked without the invoice. Empty means match all.
Revenue ledger account ID used for invoice line revenue routing.
"lac_abc123def456"
Deferred revenue ledger account ID used before revenue is recognized.
"lac_abc123def456"
Deferred discount ledger account ID used before discounts are recognized.
"lac_abc123def456"
Contra revenue ledger account ID used for amounts that reduce revenue.
"lac_abc123def456"
Discount ledger account ID used for recognized discounts.
"lac_abc123def456"
Accounts receivable ledger account ID used for invoice posting.
"lac_abc123def456"
Cash ledger account ID used for payment settlement.
"lac_abc123def456"
Payments clearing ledger account ID used while payments settle.
"lac_abc123def456"
Output tax ledger account ID used for tax liability.
"lac_abc123def456"
Ledger account ID debited when an invoice becomes uncollectible. Use an asset account for doubtful-receivable reclassification or an expense account for direct write-off.
"lac_abc123def456"
Allowance for doubtful accounts ledger account ID, set on credit_note_created rules.
"lac_abc123def456"
Expense ledger account ID debited for payment provider fees when a payment settles.
"lac_abc123def456"
Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over provider_fees_expense_ledger_account_id when set by the same or a higher priority rule.
"lac_abc123def456"
Payment processing fees revenue ledger account ID, set on invoice_settled rules.
"lac_abc123def456"
Customer credits ledger account ID used for credit balances.
"lac_abc123def456"
Revenue recognition method.
none, point_in_time, over_time, usage_based, milestone, manual "over_time"
Recognition period granularity. Used when rev_rec_method is over_time.
day, month, quarter, year "month"
Date revenue is recognized on. Used when rev_rec_method is point_in_time.
invoice_date, service_start_date, service_end_date, custom_date "service_end_date"
Method used to recognize discounts.
immediate, deferred, use_net_amount "deferred"
Journal ID used to route entries in the accounting provider.
"jou_abc123def456"
Entity type the rule applies to.
"invoice"
Timestamp when the rule was created.
Timestamp when the rule was last updated.
Expanded revenue ledger account reference when available.

